home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / fan_120.zip / FAN.DOC < prev    next >
Text File  |  1992-09-19  |  6KB  |  151 lines
  1.      
  2.      
  3.      
  4.      
  5.      
  6.      
  7.      
  8.                                     FAN
  9.      
  10.                          File Announcement Utility
  11.                                         
  12.                              Version 1.20 beta
  13.                                         
  14.                                         
  15.                                         
  16.                                         
  17.                                         
  18.                                         
  19.                                         
  20.                                         
  21.                                         
  22.                                         
  23.                                         
  24.                                         
  25.                                         
  26.                                 Dave Fisher
  27.                                         
  28.                         LiveNet, 1:170/110@fidonet
  29.      
  30.      
  31.      Description
  32.      
  33.      FAN is a utility that will create fidonet mail packet files
  34.      (*.PKT) to announce the arrival of files via a file distribution
  35.      system that uses Barry Geller's TIC file format or the standard
  36.      FILES.BBS file format.  Many of the ideas for this program have
  37.      come from Doug Belkofer's program RFD (Received For
  38.      Distribution), which worked soley on TIC files under MS-DOS.
  39.      
  40.      I created FAN since there were some things that RFD did not do
  41.      (such as support long file descriptions, FAN allows up to 1024
  42.      characters for a description, announcements from FILES.BBS files,
  43.      etc.) and was a DOS only program (and I wanted to run it
  44.      specifically under OS/2).
  45.      
  46.      FAN is a bound utility, which means that it will run under DOS or
  47.      OS/2.
  48.      
  49.      There are now two version of FAN.  A 16-bit version for DOS and
  50.      OS/2 1.x, and a 32-bit version which will only run under OS/2
  51.      2.x.  The DOS/OS2 1.x/16-bit version is named FAN16.EXE.  The
  52.      OS/2 2.0/32-bit version is named FAN32.EXE.
  53.      
  54.      Currently, FAN does everything I need it to do.  If you find that
  55.      you need it to do something different, I would be interested in
  56.      hearing your suggestions, which could very well become part of a
  57.      future release.
  58.      
  59.      Please note that this is a BETA release.  I wrote the initial
  60.      program over the weekend, and have not sufficiently tested it
  61.      yet.  If you decide to use FAN, and run across any bugs, please
  62.      let me know and I will promptly fix the program and make a new
  63.      version available to you.
  64.      
  65.      In addition to this brief document, there are also important
  66.      notes in the configuration file that comes distributed with FAN.
  67.      
  68.      The most recent version of FAN can be file-requested from me with
  69.      the magic name of "FAN" (quotes not included) at 1:170/110.
  70.      
  71.      Usage
  72.      
  73.      Fan
  74.          /Config = <path+file name>          default: Fan.cfg
  75.          /[no]Log                            default: NoLog
  76.          /LogFile = <path+file name>         default: None
  77.          /LogLevel = <1..4>                  default: 4
  78.          /[no]Quiet                          default: NoQuiet
  79.          /TossLogFile = <path+file name>     default: None
  80.      
  81.      Notes on the syntax:
  82.      
  83.           Qualifiers can appear in any order, in any case, and are
  84.           only significant to four characters.  Thus, /TossLogFile is
  85.           the same as /toss.
  86.           
  87.      
  88.      Disclaimer!
  89.      
  90.      This program is shareware.  There is absolutely no warranty for
  91.      this program or guarantee that it will work.  The user of the
  92.      program assumes all risk.  While I feel confident that this
  93.      program will not harm your system in any way, by using this
  94.      program, you agree to assume full responsibility for any adverse
  95.      effect to your system.
  96.      
  97.      Ok.  Now with that out of the way -- please send me mail and let
  98.      me know if you are using FAN!  I'd like to get an idea of whether
  99.      this program has been useful for others, as it has been for me.
  100.      Also, please send any comments, suggestions and/or problem
  101.      reports.  I can be reached at:
  102.      
  103.           Dave Fisher
  104.           LiveNet, 1:170/110@fidonet.org
  105.           
  106.           
  107.      Qualifiers
  108.      
  109.      Config = <path+file name>
  110.      ---------------------------------------------------------
  111.      
  112.      This is the name of the configuration file.  The default is
  113.      Fan.Cfg in the current directory.  You can also define the
  114.      environment variable FAN_CONFIG=<path+file name> instead of using
  115.      this qualifier.
  116.      
  117.      /[no]Log
  118.      ---------------------------------------------------------
  119.      
  120.      This qualifier will turn the logging function on and off.
  121.      
  122.      /LogFile = <path+file name>
  123.      ---------------------------------------------------------
  124.      
  125.      This qualifier defines the name of the log file.
  126.      
  127.      /LogLevel = <1..4>
  128.      ---------------------------------------------------------
  129.      
  130.      This qualifier defines the level of message detail in the log
  131.      file.  Level 1 is the least detailed, while Level 4 is the most
  132.      verbose.  The levels indicate the 'importance' of a message,
  133.      where Level 1 is the most important (usually error messages).
  134.      
  135.      /[no]Quiet
  136.      ---------------------------------------------------------
  137.      
  138.      This qualifier controls whether the program should emit an
  139.      printed output.  If /Quiet, the only output will be the program
  140.      copyright line and any error messages.  The default is /NoQuiet.
  141.      
  142.      /TossLogFile
  143.      ---------------------------------------------------------
  144.      
  145.      This qualifier specifies the name of a file to receive the names
  146.      of message areas for which mail packets were created.  The name
  147.      of the message area will be written to this file, one to a line.
  148.      This file can then be used with a tosser/scanner (such as Squish
  149.      or oMMM) to only scan the areas listed.
  150.      
  151.